Skip to content

fix: update contributing#2344

Merged
StarpTech merged 6 commits intomainfrom
milinda/update-contributing
Dec 2, 2025
Merged

fix: update contributing#2344
StarpTech merged 6 commits intomainfrom
milinda/update-contributing

Conversation

@SkArchon
Copy link
Copy Markdown
Contributor

@SkArchon SkArchon commented Nov 19, 2025 •
edited by coderabbitai Bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with additional information about development dependencies.

Checklist

@SkArchon SkArchon requested review from a team as code owners November 19, 2025 17:24
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 19, 2025 •
edited
Loading

Walkthrough

Added documentation to CONTRIBUTING.md describing Bun as a non-core dependency used for building and testing TypeScript-based router plugins and integration tests in a new Other Dependencies subsection under Prerequisites.

Changes

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md		 Added "Other Dependencies" subsection under Prerequisites documenting Bun as a non-core dependency for TypeScript router plugin development and integration testing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'fix: update contributing' is vague and generic. It uses the non-descriptive term 'update contributing' without specifying what was added or changed in the CONTRIBUTING.md file. Improve the title to be more specific about the actual change, such as 'docs: add Bun as a non-core dependency in CONTRIBUTING.md' or 'docs: document Other Dependencies prerequisites'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dde0ec0 and 8e1c98a.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
🔇 Additional comments (1)
CONTRIBUTING.md (1)

21-26: New "Other Dependencies" section is well-structured and documentation link verified.

The section clearly distinguishes between core and non-core requirements, provides an accurate and current documentation link, and explains the specific use case for Bun. The placement and formatting are consistent with the existing document structure. The Bun installation documentation link has been verified as current and accessible as of November 19, 2025.

Comment @coderabbitai help to get the list of available commands and usage tips.

StarpTech
StarpTech approved these changes Nov 20, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@StarpTech StarpTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@StarpTech StarpTech merged commit 9be1a0e into main Dec 2, 2025
7 checks passed
@StarpTech StarpTech deleted the milinda/update-contributing branch December 2, 2025 09:30
@coderabbitai coderabbitai Bot mentioned this pull request Mar 3, 2026
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ysmolski ysmolski ysmolski approved these changes

@StarpTech StarpTech StarpTech approved these changes

@wilsonrivera wilsonrivera Awaiting requested review from wilsonrivera wilsonrivera is a code owner automatically assigned from wundergraph/cosmo

@JivusAyrus JivusAyrus Awaiting requested review from JivusAyrus JivusAyrus is a code owner automatically assigned from wundergraph/cosmo

@alepane21 alepane21 Awaiting requested review from alepane21 alepane21 is a code owner automatically assigned from wundergraph/router

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SkArchon @ysmolski @StarpTech